UserCredentials

The user credential object used to set a user's login settings.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

password

The user's password.

Y

string

domain

The URL web domain - needed only for embedded authentication.

 -

string

customData

Custom data input for usage within the product.

 -

string

username

The user's login identity The format depends on the authentication provider: Its 'username' for internal database authentication. For AD, its either UPN or 'domain\username'.

Y

string

*Required elements are only used for API parameters

Usages
  • /API2/auth/authenticateUser
  • /API2/auth/authenticateUserEmbed
  • /API3/authentication/authenticateUser
  • /API3/authentication/authenticateUserEmbed